markdown-escapes

What is markdown-escapes?

The markdown-escapes package is designed to help with escaping and unescaping characters in Markdown text. It provides a straightforward API for handling characters that have special meanings in Markdown syntax, making it easier to work with Markdown programmatically. This can be particularly useful when generating Markdown content dynamically or when processing and sanitizing user-generated Markdown content.

What are markdown-escapes's main functionalities?

Escaping Markdown characters

This feature allows you to escape special Markdown characters in a string, preventing them from being interpreted as Markdown syntax. This is useful when you want to display these characters as plain text in a Markdown document.

const markdownEscapes = require('markdown-escapes');
const text = 'Markdown *text* with special characters';
const escapedText = markdownEscapes.escape(text);
console.log(escapedText);

Unescaping Markdown characters

This feature enables you to unescape previously escaped Markdown characters in a string, allowing them to be interpreted as Markdown syntax again. This can be useful when processing or transforming Markdown content that has been escaped for storage or transmission.

const markdownEscapes = require('markdown-escapes');
const escapedText = 'Markdown \*text\* with special characters';
const unescapedText = markdownEscapes.unescape(escapedText);
console.log(unescapedText);

Other packages similar to markdown-escapes

markdown-it

markdown-it is a powerful Markdown parser and renderer. While it focuses more on converting Markdown into HTML, it also offers a range of plugins that can handle escaping and unescaping of Markdown content, among other functionalities. Compared to markdown-escapes, markdown-it provides a broader set of features for working with Markdown, making it suitable for more complex Markdown processing tasks.

remarkable

remarkable is another comprehensive Markdown parser that supports a wide range of Markdown extensions and features. It includes capabilities for escaping special characters in Markdown, similar to markdown-escapes, but also offers a full suite of Markdown processing tools, including parsing, rendering, and plugin support. This makes remarkable a more versatile option for users who need more than just character escaping.

README

markdown-escapes

List of escapable characters in markdown.

Install

npm:

npm install markdown-escapes

Use

var escapes = require('markdown-escapes');

// Access by property:
escapes.commonmark; //=> ['\\', '`', ..., '@', '^']

// Access by options object:
escapes({gfm: true}); //=> ['\\', '`', ..., '~', '|']

API

escapes([options])

Get escapes. Supports options.commonmark and options.gfm, which when true returns the extra escape characters supported by those flavors.

Returns

Array.<string>.

escapes.default

List of default escapable characters.

escapes.gfm

List of escapable characters in GFM (which includes all defaults).

escapes.commonmark

List of escapable characters in CommonMark (which includes all gfms).

License

MIT © Titus Wormer